Skip to content

docs: refresh README preview assets - #1258

Merged
ZhuLinsen merged 1 commit into
mainfrom
codex/update-readme-preview
May 10, 2026
Merged

docs: refresh README preview assets#1258
ZhuLinsen merged 1 commit into
mainfrom
codex/update-readme-preview

Conversation

@ZhuLinsen

@ZhuLinsen ZhuLinsen commented May 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Owner

Summary

  • Add a smaller light-theme Web workspace GIF to the multilingual README homepages.
  • Keep the existing sponsor-first README structure and original sample-output sections.
  • Condense the multilingual feature tables and remove the old static FastAPI screenshot reference.
  • Add an Unreleased changelog entry for the README refresh.

Why

The README homepage already had the right overall structure, but its visual material was stale and the feature table was too verbose. This keeps the original layout intact while making the project capability easier to understand at a glance without adding extra static screenshots.

Validation

  • git diff --check
  • Local README image/document link check with a small Node script
  • Verified the new GIF metadata: 720x633, 6.0s, 36 frames, about 2.2MB

Risk / Rollback

Docs/assets only. Rollback by reverting this commit and removing sources/readme_workspace_tour_20260510.gif.

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/M labels May 10, 2026
@ZhuLinsen
ZhuLinsen marked this pull request as ready for review May 10, 2026 11:32
Copilot AI review requested due to automatic review settings May 10, 2026 11:32
@github-actions

github-actions Bot commented May 10, 2026 •
edited
Loading

Copy link
Copy Markdown

🤖 自动审查报告

项目 结果
📊 变更文件 5 个
➕ 新增行数 46 行
➖ 删除行数 51 行
🔍 静态检查 ✅ 通过
🧠 AI 审查 ✅ 已完成

📁 修改的文件

  • 📝 README.md (+15/-17)
  • 📝 docs/CHANGELOG.md (+1/-0)
  • 📝 docs/README_CHT.md (+15/-17)
  • 📝 docs/README_EN.md (+15/-17)
  • 🆕 docs/assets/readme_workspace_tour_20260510.gif (+0/-0)

🧠 AI 代码审查意见

结论

Ready to Merge

结构化审查结果

必要性

  • 通过
  • 理由：PR 描述明确指出了现有 README 的视觉材料陈旧和功能表格冗长的问题。此次更新旨在通过刷新视觉内容和精简信息，使项目能力一目了然，提升用户体验，具有明确的业务价值。

关联性

  • 通过
  • 证据：尽管没有明确关联的 issue ID，但 PR 描述中的“Why”部分清晰地阐述了此次变更的动机（“The README homepage already had the right overall structure, but its visual material was stale and the feature table was too verbose.”），符合自然语言关联的条件。

类型

  • 建议类型：docs
  • 理由：PR 标题 docs: refresh README preview assets 与实际修改的文件类型（全部为文档和新增的资产文件）完全匹配。

描述完整性

  • 完整
  • 理由：
    • 背景与范围：PR Summary 部分清晰地概述了变更内容，包括新增 GIF、保持现有结构、精简功能表格和移除旧截图，并说明了 WHY。
    • 验证命令与结果：提供了详细的验证方法，包括 git diff --check、本地 README 链接检查（使用 Node 脚本）以及对新 GIF 文件的元数据验证（尺寸、时长、帧数、大小），这非常充分。
    • CI 检查状态：PR 信息中明确指出“静态检查总体结果: ✅ 通过”，且“Python 文件: 无变更，语法检查已跳过”。由于本次变更不涉及 Python 后端代码，./scripts/ci_gate.sh 的执行情况不构成审查要素。
    • 兼容性风险：明确指出“Docs/assets only”，风险极低。
    • 回滚方案：提供了清晰的回滚步骤（“Rollback by reverting this commit and removing sources/readme_workspace_tour_20260510.gif。”）。

风险级别

  • 低
  • 关键风险：本次变更仅涉及文档和静态资源，不包含任何代码逻辑修改，因此风险极低。主要的风险点在于文档链接或图像路径错误，但 PR 描述中已提及进行了本地链接检查。

必改项

无

建议项

无

💡 提示: 请确保代码已通过本地测试，并遵循项目代码规范。

@ZhuLinsen
ZhuLinsen force-pushed the codex/update-readme-preview branch from fdb516d to 120c6be Compare May 10, 2026 11:33
Copilot AI reviewed May 10, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the project’s README “homepage” presentation across Chinese/English/Traditional Chinese, adding an up-to-date workspace preview asset and simplifying the feature overview to improve at-a-glance readability.

Changes:

  • Added a new “Product Preview” section with a light-theme Web workspace GIF to all multilingual README homepages.
  • Condensed the feature tables and removed the old static FastAPI screenshot reference from the Web UI sections.
  • Appended an [Unreleased] changelog entry documenting the README refresh.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated no comments.

File Description
README.md Adds product preview GIF and simplifies the feature table; removes the old Web UI screenshot reference.
docs/README_EN.md Mirrors the README refresh in English with the same preview GIF and condensed feature table.
docs/README_CHT.md Mirrors the README refresh in Traditional Chinese with the same preview GIF and condensed feature table.
docs/CHANGELOG.md Adds an Unreleased entry noting the multilingual README homepage refresh.

@ZhuLinsen
ZhuLinsen force-pushed the codex/update-readme-preview branch from 120c6be to f3711d0 Compare May 10, 2026 11:44
@ZhuLinsen
ZhuLinsen marked this pull request as draft May 10, 2026 11:45
@ZhuLinsen
ZhuLinsen force-pushed the codex/update-readme-preview branch from f3711d0 to 49e041f Compare May 10, 2026 11:49
@ZhuLinsen
ZhuLinsen marked this pull request as ready for review May 10, 2026 11:52
@ZhuLinsen
ZhuLinsen force-pushed the codex/update-readme-preview branch from 49e041f to bad290e Compare May 10, 2026 11:57
ZhuLinsen
ZhuLinsen commented May 10, 2026
View reviewed changes

@ZhuLinsen ZhuLinsen left a comment

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

评审结论

  • 必要性：通过。README 首页视觉资产和功能表精简属于首页级信息维护，符合 AGENTS.md 对 README 定位的边界。
  • 是否有对应 issue：无。未检测到 Fixes/Closes/Refs 关联语句；本次为低风险 docs/assets 刷新，不强制要求 issue。
  • PR 类型：docs。改动仅涉及多语言 README、CHANGELOG 和 README 预览 GIF 资源。
  • description 完整性：基本完整。已有 Summary、Why、Validation、Risk/Rollback；但回滚说明中的资源路径与实际新增文件路径不一致。
  • 是否可直接合入：可。当前 CI 为 success，改动面为文档/图片资源，CHANGELOG 的 [Unreleased] 条目符合扁平格式，多语言 README 已同步更新；mergeable_state=blocked 更像分支保护/权限状态，不单独构成代码阻断。

主要问题

  1. [Nice to have] PR 描述的 Rollback 写的是移除 sources/readme_workspace_tour_20260510.gif，但实际新增文件是 docs/assets/readme_workspace_tour_20260510.gif。这不会阻断合入，但建议修正文案，避免后续回滚指引误导维护者。

🤖 此回复由 OpenReview Bot 自动生成，仅供参考。如有疑问请 @维护者。

@ZhuLinsen
ZhuLinsen merged commit 6c5a17a into main May 10, 2026
10 checks passed
EchoingFootsteps pushed a commit to EchoingFootsteps/daily_stock_analysis that referenced this pull request Jul 4, 2026
@ZhuLinsen @EchoingFootsteps
docs: align README preview assets with docs directory (ZhuLinsen#1258)
b8c0343
bmwu pushed a commit to bmwu/daily_stock_analysis that referenced this pull request Aug 24, 2026
@ZhuLinsen
docs: align README preview assets with docs directory (ZhuLinsen#1258)
88d41e4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation size/M

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ZhuLinsen